<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta content="en" name="language">
	<title>composite</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">

</head>

<body>

<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
  <input type="hidden" name="domains" value="www.graphicsmagick.org" />
  <input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" />&nbsp;<input type="submit" name="sa" value="Search" /></span>
</form>
</div>


<div class="navmenu">
<ul>
  <li><a href="../index.html">Home</a></li>
  <li><a href="../project.html">Project</a></li>
  <li><a href="../download.html">Download</a></li>
  <li><a href="../README.html">Install</a></li>
  <li><a href="../Hg.html">Source</a></li>
  <li><a href="../NEWS.html">News</a> </li>
  <li><a href="../utilities.html">Utilities</a></li>
  <li><a href="../programming.html">Programming</a></li>
  <li><a href="../reference.html">Reference</a></li>
</ul>
</div>

<main id="composite">
<h1 class="title">composite</h1>
<p class="subtitle" id="merge-image-pixels-using-a-specified-algorithm">Merge image pixels using a specified algorithm</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#compositeimage" id="id1">CompositeImage</a></p></li>
</ul>
</div>
<section id="compositeimage">
<h1><a class="toc-backref" href="#id1">CompositeImage</a></h1>
<section id="synopsis">
<h2>Synopsis</h2>
<pre class="literal-block">MagickPassFail CompositeImage( <a class="reference external" href="../api/types.html#image">Image</a> *canvas_image, const <a class="reference external" href="../api/types.html#compositeoperator">CompositeOperator</a> compose,
                               const <a class="reference external" href="../api/types.html#image">Image</a> *composite_image, const long x_offset,
                               const long y_offset );</pre>
</section>
<section id="description">
<h2>Description</h2>
<p>CompositeImage() composites the second image (composite_image) onto the
first (canvas_image) at the specified offsets.</p>
<p>The format of the CompositeImage method is:</p>
<pre class="literal-block">MagickPassFail CompositeImage( <a class="reference external" href="../api/types.html#image">Image</a> *canvas_image, const <a class="reference external" href="../api/types.html#compositeoperator">CompositeOperator</a> compose,
                               const <a class="reference external" href="../api/types.html#image">Image</a> *composite_image, const long x_offset,
                               const long y_offset );</pre>
<dl class="simple">
<dt>canvas_image:</dt>
<dd><p>The image to be updated.</p>
</dd>
<dt>compose:</dt>
<dd><p>This operator affects how the composite is applied to
the image.  Choose from one of these operators: AddCompositeOp,
AtopCompositeOp, BumpmapCompositeOp, ClearCompositeOp,
ColorizeCompositeOp, CopyBlackCompositeOp, CopyBlueCompositeOp,
CopyCompositeOp, CopyCyanCompositeOp,CopyGreenCompositeOp,
CopyMagentaCompositeOp, CopyOpacityCompositeOp, CopyRedCompositeOp,
CopyYellowCompositeOp, DarkenCompositeOp, DifferenceCompositeOp,
DisplaceCompositeOp, DissolveCompositeOp, DivideCompositeOp,
HueCompositeOp, InCompositeOp, LightenCompositeOp, LuminizeCompositeOp,
MinusCompositeOp, ModulateCompositeOp, MultiplyCompositeOp,
NoCompositeOp, OutCompositeOp, OverlayCompositeOp, PlusCompositeOp,
SaturateCompositeOp, ScreenCompositeOp, SubtractCompositeOp,
ThresholdCompositeOp, XorCompositeOp, HardLightCompositeOp.</p>
</dd>
<dt>composite_image:</dt>
<dd><p>The composite image.</p>
</dd>
<dt>x_offset:</dt>
<dd><p>The column offset of the composited image.</p>
</dd>
<dt>y_offset:</dt>
<dd><p>The row offset of the composited image.</p>
</dd>
</dl>
</section>
</section>
</main>


<hr class="docutils">
<div class="document">
    <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002-2025<!--SPONSOR_LOGO--></p>
</div>

</main>
</body>
</html>
